<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>thread_pool::basic_executor_type</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="thread_pool/_thread_pool.html" title="thread_pool::~thread_pool">
    <link rel="next" href="thread_pool__basic_executor_type/basic_executor_type.html"
          title="thread_pool::basic_executor_type::basic_executor_type">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="thread_pool/_thread_pool.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                      href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="thread_pool__basic_executor_type/basic_executor_type.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.thread_pool__basic_executor_type"></a><a class="link"
                                                                                 href="thread_pool__basic_executor_type.html"
                                                                                 title="thread_pool::basic_executor_type">thread_pool::basic_executor_type</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.thread_pool__basic_executor_type"></a>
    </p>
    <p>
        Executor implementation type used to submit functions to a thread pool.
    </p>
    <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">typename</span> <span class="identifier">Allocator</span><span class="special">,</span>
    <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Bits</span><span
                class="special">&gt;</span>
<span class="keyword">class</span> <span class="identifier">basic_executor_type</span>
</pre>
    <h5>
        <a name="asio.reference.thread_pool__basic_executor_type.h0"></a>
        <span><a name="asio.reference.thread_pool__basic_executor_type.types"></a></span><a class="link"
                                                                                            href="thread_pool__basic_executor_type.html#asio.reference.thread_pool__basic_executor_type.types">Types</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/index_type.html"
                           title="thread_pool::basic_executor_type::index_type"><span
                                class="bold"><strong>index_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The bulk execution index type.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/sender_type.html"
                           title="thread_pool::basic_executor_type::sender_type"><span
                                class="bold"><strong>sender_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The sender type, when this type is used as a scheduler.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/shape_type.html"
                           title="thread_pool::basic_executor_type::shape_type"><span
                                class="bold"><strong>shape_type</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        The bulk execution shape type.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.thread_pool__basic_executor_type.h1"></a>
        <span><a name="asio.reference.thread_pool__basic_executor_type.member_functions"></a></span><a class="link"
                                                                                                       href="thread_pool__basic_executor_type.html#asio.reference.thread_pool__basic_executor_type.member_functions">Member
        Functions</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/basic_executor_type.html"
                           title="thread_pool::basic_executor_type::basic_executor_type"><span class="bold"><strong>basic_executor_type</strong></span></a>
                        <span class="silver">[constructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Copy constructor. <br> <span class="silver"> —</span><br> Move constructor.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/bulk_execute.html"
                           title="thread_pool::basic_executor_type::bulk_execute"><span class="bold"><strong>bulk_execute</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Bulk execution function.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/connect.html"
                           title="thread_pool::basic_executor_type::connect"><span class="bold"><strong>connect</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Connect function.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/context.html"
                           title="thread_pool::basic_executor_type::context"><span class="bold"><strong>context</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Obtain the underlying execution context.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/defer.html"
                           title="thread_pool::basic_executor_type::defer"><span
                                class="bold"><strong>defer</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Request the thread pool to invoke the given function object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/dispatch.html"
                           title="thread_pool::basic_executor_type::dispatch"><span
                                class="bold"><strong>dispatch</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Request the thread pool to invoke the given function object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/execute.html"
                           title="thread_pool::basic_executor_type::execute"><span class="bold"><strong>execute</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Execution function.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/on_work_finished.html"
                           title="thread_pool::basic_executor_type::on_work_finished"><span class="bold"><strong>on_work_finished</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Inform the thread pool that some work is no longer outstanding.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/on_work_started.html"
                           title="thread_pool::basic_executor_type::on_work_started"><span class="bold"><strong>on_work_started</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Inform the thread pool that it has some outstanding work to do.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/operator_eq_.html"
                           title="thread_pool::basic_executor_type::operator="><span
                                class="bold"><strong>operator=</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Assignment operator. <br> <span class="silver"> —</span><br> Move assignment operator.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/post.html"
                           title="thread_pool::basic_executor_type::post"><span
                                class="bold"><strong>post</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Request the thread pool to invoke the given function object.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/query.html"
                           title="thread_pool::basic_executor_type::query"><span
                                class="bold"><strong>query</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Query the current value of the context property. <br> <span class="silver"> —</span><br>
                        Query the current value of the blocking property. <br> <span class="silver"> —</span><br>
                        Query the current value of the relationship property. <br> <span class="silver"> —</span><br>
                        Query the current value of the allocator property. <br> <span class="silver"> —</span><br>
                        Query the occupancy (recommended number of work items) for the
                        pool.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/query__static.html"
                           title="thread_pool::basic_executor_type::query"><span
                                class="bold"><strong>query</strong></span></a> <span class="silver">[static]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Query the current value of the bulk_guarantee property. <br>
                        <span class="silver"> —</span><br> Query the current value of the mapping property. <br>
                        <span class="silver"> —</span><br> Query the current value of the outstanding_work property.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/require.html"
                           title="thread_pool::basic_executor_type::require"><span class="bold"><strong>require</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Obtain an executor with the blocking.possibly property. <br>
                        <span class="silver"> —</span><br> Obtain an executor with the blocking.always property. <br>
                        <span class="silver"> —</span><br> Obtain an executor with the blocking.never property. <br>
                        <span class="silver"> —</span><br> Obtain an executor with the relationship.fork property.
                        <br> <span class="silver"> —</span><br> Obtain an executor with the relationship.continuation
                        property. <br> <span class="silver"> —</span><br> Obtain an executor with the
                        outstanding_work.tracked
                        property. <br> <span class="silver"> —</span><br> Obtain an executor with the
                        outstanding_work.untracked
                        property. <br> <span class="silver"> —</span><br> Obtain an executor with the specified
                        allocator
                        property. <br> <span class="silver"> —</span><br> Obtain an executor with the default allocator
                        property.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/running_in_this_thread.html"
                           title="thread_pool::basic_executor_type::running_in_this_thread"><span class="bold"><strong>running_in_this_thread</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Determine whether the thread pool is running in the current thread.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/schedule.html"
                           title="thread_pool::basic_executor_type::schedule"><span
                                class="bold"><strong>schedule</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Schedule function.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/_basic_executor_type.html"
                           title="thread_pool::basic_executor_type::~basic_executor_type"><span class="bold"><strong>~basic_executor_type</strong></span></a>
                        <span class="silver">[destructor]</span>
                    </p>
                </td>
                <td>
                    <p>
                        Destructor.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.thread_pool__basic_executor_type.h2"></a>
        <span><a name="asio.reference.thread_pool__basic_executor_type.friends"></a></span><a class="link"
                                                                                              href="thread_pool__basic_executor_type.html#asio.reference.thread_pool__basic_executor_type.friends">Friends</a>
    </h5>
    <div class="informaltable">
        <table class="table">
            <colgroup>
                <col>
                <col>
            </colgroup>
            <thead>
            <tr>
                <th>
                    <p>
                        Name
                    </p>
                </th>
                <th>
                    <p>
                        Description
                    </p>
                </th>
            </tr>
            </thead>
            <tbody>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/operator_not__eq_.html"
                           title="thread_pool::basic_executor_type::operator!="><span
                                class="bold"><strong>operator!=</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Compare two executors for inequality.
                    </p>
                </td>
            </tr>
            <tr>
                <td>
                    <p>
                        <a class="link" href="thread_pool__basic_executor_type/operator_eq__eq_.html"
                           title="thread_pool::basic_executor_type::operator=="><span
                                class="bold"><strong>operator==</strong></span></a>
                    </p>
                </td>
                <td>
                    <p>
                        Compare two executors for equality.
                    </p>
                </td>
            </tr>
            </tbody>
        </table>
    </div>
    <h5>
        <a name="asio.reference.thread_pool__basic_executor_type.h3"></a>
        <span><a name="asio.reference.thread_pool__basic_executor_type.requirements"></a></span><a class="link"
                                                                                                   href="thread_pool__basic_executor_type.html#asio.reference.thread_pool__basic_executor_type.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/thread_pool.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="thread_pool/_thread_pool.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                                      href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="thread_pool__basic_executor_type/basic_executor_type.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
